<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ipipsu: xipipsu.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ipipsu
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xipipsu_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xipipsu.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ipi_psu___target.html">XIpiPsu_Target</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structure used to refer IPI Targets.  <a href="struct_x_ipi_psu___target.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ipi_psu___config.html">XIpiPsu_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the device.  <a href="struct_x_ipi_psu___config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="struct_x_ipi_psu.html" title="The XIpiPsu driver instance data. ">XIpiPsu</a> driver instance data.  <a href="struct_x_ipi_psu.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gac400a6861c1d0ee565ad5fac914a7220"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#gac400a6861c1d0ee565ad5fac914a7220">XIpiPsu_ReadReg</a>(BaseAddress,  RegOffset)&#160;&#160;&#160;Xil_In32((BaseAddress) + (RegOffset))</td></tr>
<tr class="memdesc:gac400a6861c1d0ee565ad5fac914a7220"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the register specified by the base address and offset.  <a href="group__ipipsu__v1__0.html#gac400a6861c1d0ee565ad5fac914a7220">More...</a><br /></td></tr>
<tr class="separator:gac400a6861c1d0ee565ad5fac914a7220"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga72bcaac2f32ad480f79204f868309c31"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">XIpiPsu_WriteReg</a>(BaseAddress,  RegOffset,  Data)&#160;&#160;&#160;Xil_Out32(((BaseAddress) + (RegOffset)), (Data))</td></tr>
<tr class="memdesc:ga72bcaac2f32ad480f79204f868309c31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a value into a register specified by base address and offset.  <a href="group__ipipsu__v1__0.html#ga72bcaac2f32ad480f79204f868309c31">More...</a><br /></td></tr>
<tr class="separator:ga72bcaac2f32ad480f79204f868309c31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa4e2694e0d28168f195f87583a34190c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#gaa4e2694e0d28168f195f87583a34190c">XIpiPsu_InterruptEnable</a>(InstancePtr,  Mask)</td></tr>
<tr class="memdesc:gaa4e2694e0d28168f195f87583a34190c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable interrupts specified in <em>Mask</em>.  <a href="group__ipipsu__v1__0.html#gaa4e2694e0d28168f195f87583a34190c">More...</a><br /></td></tr>
<tr class="separator:gaa4e2694e0d28168f195f87583a34190c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad78cbbfba9e09be384e1fbe733f3dc12"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#gad78cbbfba9e09be384e1fbe733f3dc12">XIpiPsu_InterruptDisable</a>(InstancePtr,  Mask)</td></tr>
<tr class="memdesc:gad78cbbfba9e09be384e1fbe733f3dc12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable interrupts specified in <em>Mask</em>.  <a href="group__ipipsu__v1__0.html#gad78cbbfba9e09be384e1fbe733f3dc12">More...</a><br /></td></tr>
<tr class="separator:gad78cbbfba9e09be384e1fbe733f3dc12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b24a8f18c8abc17b7a26532da88cc7e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga5b24a8f18c8abc17b7a26532da88cc7e">XIpiPsu_GetInterruptStatus</a>(InstancePtr)</td></tr>
<tr class="memdesc:ga5b24a8f18c8abc17b7a26532da88cc7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <em>STATUS REGISTER</em> of the current IPI instance.  <a href="group__ipipsu__v1__0.html#ga5b24a8f18c8abc17b7a26532da88cc7e">More...</a><br /></td></tr>
<tr class="separator:ga5b24a8f18c8abc17b7a26532da88cc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2919c49f2a05d552dedb148069e84045"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga2919c49f2a05d552dedb148069e84045">XIpiPsu_ClearInterruptStatus</a>(InstancePtr,  Mask)</td></tr>
<tr class="memdesc:ga2919c49f2a05d552dedb148069e84045"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the <em>STATUS REGISTER</em> of the current IPI instance.  <a href="group__ipipsu__v1__0.html#ga2919c49f2a05d552dedb148069e84045">More...</a><br /></td></tr>
<tr class="separator:ga2919c49f2a05d552dedb148069e84045"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a62cac5d53ded4028a5f1586e390645"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga4a62cac5d53ded4028a5f1586e390645">XIpiPsu_GetObsStatus</a>(InstancePtr)</td></tr>
<tr class="memdesc:ga4a62cac5d53ded4028a5f1586e390645"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <em>OBSERVATION REGISTER</em> of the current IPI instance.  <a href="group__ipipsu__v1__0.html#ga4a62cac5d53ded4028a5f1586e390645">More...</a><br /></td></tr>
<tr class="separator:ga4a62cac5d53ded4028a5f1586e390645"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaaafe5e7a11e3d1fdd01a255521332272"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_ipi_psu___config.html">XIpiPsu_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#gaaafe5e7a11e3d1fdd01a255521332272">XIpiPsu_LookupConfig</a> (u32 DeviceId)</td></tr>
<tr class="memdesc:gaaafe5e7a11e3d1fdd01a255521332272"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks up the device configuration based on the unique device ID.  <a href="group__ipipsu__v1__0.html#gaaafe5e7a11e3d1fdd01a255521332272">More...</a><br /></td></tr>
<tr class="separator:gaaafe5e7a11e3d1fdd01a255521332272"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9fb4494480ae0079422956f2af1da357"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga9fb4494480ae0079422956f2af1da357">XIpiPsu_CfgInitialize</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr, <a class="el" href="struct_x_ipi_psu___config.html">XIpiPsu_Config</a> *CfgPtr, UINTPTR EffectiveAddress)</td></tr>
<tr class="memdesc:ga9fb4494480ae0079422956f2af1da357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the Instance pointer based on a given Config Pointer.  <a href="group__ipipsu__v1__0.html#ga9fb4494480ae0079422956f2af1da357">More...</a><br /></td></tr>
<tr class="separator:ga9fb4494480ae0079422956f2af1da357"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c55b8deb0e6b0a4ff355ad3a74aa2f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga9c55b8deb0e6b0a4ff355ad3a74aa2f1">XIpiPsu_Reset</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga9c55b8deb0e6b0a4ff355ad3a74aa2f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the given IPI register set.  <a href="group__ipipsu__v1__0.html#ga9c55b8deb0e6b0a4ff355ad3a74aa2f1">More...</a><br /></td></tr>
<tr class="separator:ga9c55b8deb0e6b0a4ff355ad3a74aa2f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8aa0005ec03abef3b3c1a506cb924e6e"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga8aa0005ec03abef3b3c1a506cb924e6e">XIpiPsu_TriggerIpi</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr, u32 DestCpuMask)</td></tr>
<tr class="memdesc:ga8aa0005ec03abef3b3c1a506cb924e6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trigger an IPI to a Destination CPU.  <a href="group__ipipsu__v1__0.html#ga8aa0005ec03abef3b3c1a506cb924e6e">More...</a><br /></td></tr>
<tr class="separator:ga8aa0005ec03abef3b3c1a506cb924e6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf633cefd9970c417079c0922577933e8"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#gaf633cefd9970c417079c0922577933e8">XIpiPsu_PollForAck</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr, u32 DestCpuMask, u32 TimeOutCount)</td></tr>
<tr class="memdesc:gaf633cefd9970c417079c0922577933e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Poll for an acknowledgement using Observation Register.  <a href="group__ipipsu__v1__0.html#gaf633cefd9970c417079c0922577933e8">More...</a><br /></td></tr>
<tr class="separator:gaf633cefd9970c417079c0922577933e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga64113249dac23760b5cc0e9d038f8361"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga64113249dac23760b5cc0e9d038f8361">XIpiPsu_ReadMessage</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr, u32 SrcCpuMask, u32 *MsgPtr, u32 MsgLength, u8 BufferType)</td></tr>
<tr class="memdesc:ga64113249dac23760b5cc0e9d038f8361"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read an Incoming Message from a Source.  <a href="group__ipipsu__v1__0.html#ga64113249dac23760b5cc0e9d038f8361">More...</a><br /></td></tr>
<tr class="separator:ga64113249dac23760b5cc0e9d038f8361"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga21edd11331c715ee4b2c7a34471eac0d"><td class="memItemLeft" align="right" valign="top">XStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipipsu__v1__0.html#ga21edd11331c715ee4b2c7a34471eac0d">XIpiPsu_WriteMessage</a> (<a class="el" href="struct_x_ipi_psu.html">XIpiPsu</a> *InstancePtr, u32 DestCpuMask, u32 *MsgPtr, u32 MsgLength, u8 BufferType)</td></tr>
<tr class="memdesc:ga21edd11331c715ee4b2c7a34471eac0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a Message to Destination.  <a href="group__ipipsu__v1__0.html#ga21edd11331c715ee4b2c7a34471eac0d">More...</a><br /></td></tr>
<tr class="separator:ga21edd11331c715ee4b2c7a34471eac0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
